Hybris UX Api
TMF639 - getLogicalResource
This operation allows to retrieve list of available service numbers (MSISDN) / eSIM numbers (ICCID).
URL
http://[localhost]:[port]/ecom-ux/v1/{businessId}/logicalResourceURL PARAMS
| name | type | description | required |
|---|---|---|---|
| businessId | String | 2 letter ISO 3166 country code (PA) identifying the business unit. | Y |
Headers
| name | type | description | required |
|---|---|---|---|
| client-id | String | The client-id identifying the channel. | Y |
| client-secret | String | Password associated with the client-id. | Y |
| X-Correlation-ID | String | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | N |
Query Params
| name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) |
|---|---|---|---|
| @type | String | defines the resource name | Y (PA for both usecases) |
| place.id | String | Area code of the service number (numberAreaCode) | Y (PA only for MSISDN usecase) |
| resourceStatus | String | Status of the resource Possible Values: [reserved,available] | N (PA for both usecases) |
| value | String | Value of the resource | N (PA only for MSISDN usecase) |
| relatedParty.id | String | unique identifier | Y (PA only for eSIM usecase) |
| relatedParty.role | String | Name of the related entity Possible values for PA: DEALER | Y (PA only for eSIM usecase) |
| resourceCharacteristic.name | String | Name of the characteristic Possible values for PA: SERVICE | N (PA only for eSIM usecase) |
| resourceCharacteristic.value | String | Value of the characteristic Possible values for PA: POSTPAID | N (PA only for eSIM usecase) |
| limit | Integer | Requested number of resources to be provided in response | Y (PA only for eSIM usecase) |
Data Model
Response Headers
| name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) |
|---|---|---|---|
| X-Total-Count | Integer | Actual number of items returned in the response body | Y (PA) |
Response Body
| field name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) |
|---|---|---|---|
| id | String | Identifier of an instance of the resource. Required to be unique within the resource type. | Y (PA for both usecases) |
| href | String | Hyperlink reference | Y (PA for both usecases) |
| @type | String | defines the resource name | Y (PA for both usecases) |
| resourceStatus | String | Status of the resource. Possible Values: [reserved,available] | Y (PA for both usecases) |
| resourceCharacteristic[].name | String | Name of the characteristic | Y (PA only for eSIM usecase) |
| resourceCharacteristic[].valueType | String | Data type of the value of the characteristic | Y (PA only for eSIM usecase) |
| resourceCharacteristic[].value | String | Value of the characteristic | Y (PA only for eSIM usecase) |
| relatedParty[].id | String | unique identifier | Y (PA only for eSIM usecase) |
| relatedParty[].role | String | Role played by the related party | Y (PA only for eSIM usecase) |
| relatedParty[].'@referredType' | String | The actual type of the target instance when needed for disambiguation. | Y (PA only for eSIM usecase) |
resourceCharacteristic subResource -Data Model
| field name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) | examples |
|---|---|---|---|---|
| resourceCharacteristic[].name == "IMSI" | String | International Mobile Subscriber Identity, a unique identifier for a eSIM card. | Y (PA) | PA: { "name":"IMSI", "valueType":"string", "value":"71401100786000" } |
| resourceCharacteristic[].name == "PIN1" | String | Personal Identification Number used to lock the eSIM card for security. | Y (PA) | PA: { "name":"PIN1", "valueType":"string", "value":"6012" } |
| resourceCharacteristic[].name == "PIN2" | String | Secondary PIN used for specific eSIM-related operations, like managing services. | Y (PA) | PA: { "name":"PIN2", "valueType":"string", "value":"2802" } |
| resourceCharacteristic[].name == "PUK1" | String | Personal Unblocking Key used to unblock the eSIM after multiple incorrect PIN1 attempts. | Y (PA) | PA: { "name":"PUK1", "valueType":"string", "value":"3177" } |
| resourceCharacteristic[].name == "PUK2" | String | Personal Unblocking Key used to unblock the eSIM after multiple incorrect PIN2 attempts. | Y (PA) | PA: { "name":"PUK2", "valueType":"string", "value":"3177" } |
| resourceCharacteristic[].name == "prepaidInd" | String | Indicates whether the eSIM card is for a prepaid service (True/False). | Y (PA) | PA: { "name":"prepaidInd", "valueType":"boolean", "value": false } |
| resourceCharacteristic[].name == "ACTIVATION-CODE" | String | A code used to activate the eSIM card for use with the network. | Y (PA) | PA: { "name":"ACTIVATION-CODE", "valueType":"string", "value": "1$sm-v4-099-a-gtm.pr.go-esim.com$0AFD51373501277C842B5B396BF73B87" } |
relatedParty subResource - Data Model
Note :As of now DEALER value is not yet finalized will update the public portal once it is confirmed.
| field name | type | description | required (mandatory-Y, optional-N, conditionallyMandatory-C/M, Not applicable- N/A) | examples |
|---|---|---|---|---|
| relatedParty[].'@referredType' == "Company" | String | dealerId | C/M (PA) | PA: { "id" : "", "role": "DEALER", "@referredType":"Company" } |
Keyconsiderations
PA Implementation
MSISDN Usecase
- This is implemented for mobile postpaid customers
- For MSISDN usecase applicable queryParams are: @type, place.id, resourceStatus, value.
- To retrieve available service numbers (MSISDN), set '@type' to "MSISDN" and pass valid place.id value.
- To retrieve reserved service numbers (MSISDN), set 'resourceStatus" to 'reserved' and pass valid MSISDN number in 'value' field.
- To get available service numbers 'resourceStatus' queryparam is optional.
- To get available serviceNumbers (MSISDN), refer to below sample example:
response - "PA_listAvailable_serviceNumber_Response" in API specificationESIM Usecase
- This is implemented for mobile postpaid customers
- For ESIM usecase applicable queryParams are: @type, resourceStatus, relatedParty.id, relatedParty.role, resourceCharacteristic.name, resourceCharacteristic.value, limit.
- To retrieve available eSIM numbers (ICCID), set '@type' to "ESIM".
- relatedParty[].id and relatedParty[].role are mandatory fields when '@type' equals to "ESIM".
- To retrieve available eSIM numbers (ICCID), set the resourceStatus to "available".
- To get available eSIM number 'resourceStatus' queryparam is optional. By default value "available" will be set.
- If we need to retrieve POSTPAID service numbers we need to pass resourceCharacteristic.name == "SERVICE" and resourceCharacteristic.value == "POSTPAID" else available eSIM
numbers will be returned.
- limit should be mandatory and greater than or equals to 1
- To get available eSIM (ICCID), refer to below sample example:
response - "PA_listAvailable_eSIMNumber_Response" in API specificationNote : For sample examples please refer to this URL Get LogicalResource Specification